algalcommand
Class Properties

java.lang.Object
  algalcommand.Properties

public abstract class Properties
extends java.lang.Object

The Properties class holds application-wide constants, such as the locations of important files.

Copyright Owner: Michigan State University, license number TEC2011-002101Prov

Field Summary

static java.lang.String	APPLICATION_DIRECTORY_PATH This is the filepath of the folder where the jar executable resides
static java.lang.String	DATA_TYPE_TURBIDITY This is the string in the type attribute that is sent by the PBRBrain to identify turbidity data.
static int	PBR_PORT This is the port number used for network communications
static java.lang.String	SCRIPT_DIRECTORY_PATH This string is the filepath to the folder that holds scripting related resources
static java.lang.String	SCRIPT_FUNCTION_DEINITIALIZE This is the name of the script function that is called everytime the script file is closed (such as when the program is closed or the PBR is otherwise interrupted during an experiment).
static java.lang.String	SCRIPT_FUNCTION_ENDEXPERIMENT function experimentStart(){ /* do stuff that happens only once, at the end of the experiement */ }
static java.lang.String	SCRIPT_FUNCTION_STARTEXPERIMENT function experimentStart(){ /* do stuff that happens only once, at the beginning of the experiement */ }
static java.lang.String	SCRIPT_FUNCTION_TURBIDITYEVENT This is the name of the script function that is called whenever turbidity data arrives from the hardware. function turbidityEvent(transmission){ /* Do stuff related to transmission, transmission is measured in volts*/ }
static java.io.File	SCRIPT_HEADER_FILE This File should point to the header for PBR scripts.
static long	TIMEOUT_MS How long to wait for a responce before timing out.
static java.lang.String	VARIABLE_DIRECTORY Name of the local folder that is used to store saved variables

Constructor Summary

Properties()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

APPLICATION_DIRECTORY_PATH

public static final java.lang.String APPLICATION_DIRECTORY_PATH

This is the filepath of the folder where the jar executable resides

SCRIPT_DIRECTORY_PATH

public static final java.lang.String SCRIPT_DIRECTORY_PATH

This string is the filepath to the folder that holds scripting related resources

SCRIPT_HEADER_FILE

public static final java.io.File SCRIPT_HEADER_FILE

This File should point to the header for PBR scripts. If the header is not found, there will be problems.

DATA_TYPE_TURBIDITY

public static final java.lang.String DATA_TYPE_TURBIDITY

This is the string in the type attribute that is sent by the PBRBrain to identify turbidity data.

See Also:

Constant Field Values

SCRIPT_FUNCTION_DEINITIALIZE

public static final java.lang.String SCRIPT_FUNCTION_DEINITIALIZE

This is the name of the script function that is called everytime the script file is closed (such as when the program is closed or the PBR is otherwise interrupted during an experiment). This is useful for saving important global variables to variable files.

function deinitialize(){
/* do stuff that happens right before closing the script file, such as saving persistant variables */
}

See Also:

Constant Field Values

SCRIPT_FUNCTION_TURBIDITYEVENT

public static final java.lang.String SCRIPT_FUNCTION_TURBIDITYEVENT

This is the name of the script function that is called whenever turbidity data arrives from the hardware.

function turbidityEvent(transmission){
/* Do stuff related to transmission, transmission is measured in volts*/
}

See Also:

Constant Field Values

SCRIPT_FUNCTION_STARTEXPERIMENT

public static final java.lang.String SCRIPT_FUNCTION_STARTEXPERIMENT

function experimentStart(){
/* do stuff that happens only once, at the beginning of the experiement */
}

See Also:

Constant Field Values

SCRIPT_FUNCTION_ENDEXPERIMENT

public static final java.lang.String SCRIPT_FUNCTION_ENDEXPERIMENT

function experimentStart(){
/* do stuff that happens only once, at the end of the experiement */
}

See Also:

Constant Field Values

VARIABLE_DIRECTORY

public static final java.lang.String VARIABLE_DIRECTORY

Name of the local folder that is used to store saved variables

See Also:

Constant Field Values

TIMEOUT_MS

public static final long TIMEOUT_MS

How long to wait for a responce before timing out.

See Also:

Constant Field Values

PBR_PORT

public static final int PBR_PORT

This is the port number used for network communications

See Also:

Constant Field Values

Constructor Detail

Properties

public Properties()